home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / gapdemo2.zip / QWKREP.ZIP / QWKREP.TXT < prev    next >
Encoding:
Text File  |  1993-04-19  |  9.8 KB  |  286 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                  QWK/REP Sub-System
  9.  
  10.           Description
  11.  
  12.           The QWK/REP  sub-system is  a very  basic method  to  allow  your
  13.           callers to  download QWK  packets containing  all new messages in
  14.           Forums the  callers have  selected. It  also  allows  callers  to
  15.           upload messages that were created with an off-line mail reader.
  16.  
  17.  
  18.  
  19.           Setting Up
  20.  
  21.           Setting up the QWK/REP sub-system is very similar to setting up a
  22.           door for  use with GAP. The only basic difference is that this is
  23.           NOT a  door and  must not  be configured  as part  of your  doors
  24.           system since  the commands  to activate  the modules are built in
  25.           commands and the initial prompts are a part of GAPBBS.
  26.  
  27.           Create a directory off of your DEFAULT directory called QWKREP:
  28.  
  29.                C:\GAP\QWKREP
  30.  
  31.           This directory will contain the following files:
  32.  
  33.                REPIMPRT.EXE
  34.                QWKEXPRT.EXE
  35.                QWKREPx.CNF
  36.                QWKH
  37.                QWKMENU
  38.                QWKMENUG
  39.                SEND.BAT
  40.                RECV.BAT
  41.  
  42.           The QWKREPx.CNF is a configuration file that supplies the modules
  43.           with the necessary information they need in order to run. The 'x'
  44.           is the  Node Number that the configuration applies to. If you run
  45.           single node  GAP software,  you may leave the node number off and
  46.           simply name the file QWKREP.CNF.
  47.  
  48.           QWKH is a help file that is utilized by the QWK Module.
  49.  
  50.           QWKMENU and  QWKMENUG are  Menus that  are utilized  by  the  QWK
  51.           Module.
  52.  
  53.           SEND.BAT and  RECV.BAT are  batch files that the QWK modules will
  54.           invoke to send a QWK packet and receive a REP packet.
  55.  
  56.  
  57.  
  58.           GAP Communications                             QWK/REP Sub-System
  59.  
  60.  
  61.           The configuration file consists of the following lines:
  62.  
  63.                Default Directory
  64.                Name of BBS
  65.                IRQ
  66.                Base Address
  67.                QWK/REP ID
  68.                SEND.BAT
  69.                RECV.BAT
  70.                NODOSWIN (or blank)
  71.                SYSOP NAME
  72.  
  73.           The Default  Directory is the directory where your GAPBBS.CNF and
  74.           DOOR.SYS files reside.
  75.  
  76.           The Name of BBS is your BBS Name.
  77.  
  78.           The IRQ  is the  Interrupt Request  Number  for  the  port.  This
  79.           applies only  if you  are using ports other than COM 1 and COM 2.
  80.           If you are using standard COM ports, enter a 0 on this line.
  81.  
  82.           The Base  Address is the Port address (in hexadecimal). This line
  83.           also only applies if you are using non-standard COM ports. If you
  84.           are using standard COM ports, enter a 0 on this line.
  85.  
  86.           The QWK/REP  ID is a unique Identifier for your BBS. It must be 8
  87.           characters or less in length and entered in all upper case.
  88.  
  89.           The SEND.BAT  file line  can be  given any DOS batch file name of
  90.           your choice.  When a caller requests a QWK packet, the QWK module
  91.           will call  this batch  file to  invoke DSZ  or any  other  Zmodem
  92.           protocol program.
  93.  
  94.           The following parameters will be passed to this batch file:
  95.  
  96.                %1   -    COM Port Number
  97.                %2   -    COM Port Speed (DTE bps rate)
  98.                %3   -    Caller's bps rate
  99.                %4   -    The directory where the QWK packet is located.
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.                                        Page 2
  113.  
  114.  
  115.  
  116.           GAP Communications                             QWK/REP Sub-System
  117.  
  118.  
  119.           The RECV.BAT  file line  can be  given any DOS batch file name of
  120.           your choice.  When a caller requests a REP packet, the REP or QWK
  121.           module will  call this  batch file  to invoke  DSZ or  any  other
  122.           Zmodem protocol program.
  123.  
  124.           The following parameters will be passed to this batch file:
  125.  
  126.                %1   -    COM Port Number
  127.                %2   -    COM Port Speed (DTE bps rate)
  128.                %3   -    Caller's bps rate
  129.                %4   -    The directory where the Protocol should place the
  130.                          REP packet.
  131.  
  132.           Line 8  can either  be NODOSWIN  or the  end of the configuration
  133.           file. When shelling to PKZIP or DSZ, the QWK/REP modules create a
  134.           "DOS Window"  into which  all output  will be re-directed. If you
  135.           use a  full screen  version of  DSZ or have other reasons for not
  136.           using the DOS Window, you may enter NODOSWIN on this line and the
  137.           modules will not attempt to redirect all DOS output to a window.
  138.  
  139.           Line 9  is the Sysop's Real Name. When messages are imported, any
  140.           message that  is TO  the Sysop's  real name  will be  changed  to
  141.           SYSOP.
  142.  
  143.           A sample configuration file would look like this:
  144.  
  145.                QWKREP.CNF
  146.                ---------------------------
  147.                C:\GAP
  148.                The Crow's Nest BBS
  149.                0
  150.                0
  151.                CROWNEST
  152.                SEND.BAT
  153.                RECV.BAT
  154.                USE DOS WINDOW
  155.                DARIN MAY
  156.  
  157.           If you  run multi  nodes, you  will need  a separate configuation
  158.           file for each node.
  159.  
  160.  
  161.  
  162.           Next you will need to create two batch files that GAP will invoke
  163.           when a caller types the appropriate QWK/REP command from the Main
  164.           Menu (the commands are also available from the Files Menu). These
  165.           batch files are placed in your DEFAULT directory.
  166.  
  167.  
  168.  
  169.  
  170.                                        Page 3
  171.  
  172.  
  173.  
  174.           GAP Communications                             QWK/REP Sub-System
  175.  
  176.  
  177.           The first  is called  QWK.BAT. It  is  associated  with  the  QWK
  178.           command. This  file will  invoke the QWKEXPRT.EXE module, passing
  179.           to it  the name  of the  configuration file  for the  appropriate
  180.           node. Such a file would look like this:
  181.  
  182.                QWK.BAT
  183.                ---------------------------
  184.                @echo off
  185.                c:
  186.                cd \gap\qwkrep
  187.                qwkexprt qwkrep1.cnf
  188.                c:
  189.                cd \gap
  190.  
  191.           Notice that  the file  changes  into  the  QWKREP  directory  and
  192.           invokes  the   QWKEXPRT  module,  passing  it  the  name  of  the
  193.           configuration file for Node 1. If you run muliple nodes, you will
  194.           need a  QWK.BAT file  for each  node. The only difference between
  195.           the files  would be  the drive and directory designators, and the
  196.           line that  calls up  the QWKEXPRT  module. Each  node must  use a
  197.           different configuration  file and  pass the  name of this file to
  198.           the QWKEXPRT module.
  199.  
  200.           The second  batch file  is called  REP.BAT. It is associated with
  201.           the REP  command. This  file will invoke the REPIMPRT.EXE module,
  202.           passing to  it  the  name  of  the  configuration  file  for  the
  203.           appropriate node. Such a file would look like this:
  204.  
  205.                REP.BAT
  206.                ---------------------------
  207.                @echo off
  208.                c:
  209.                cd \gap\qwkrep
  210.                repimprt qwkrep1.cnf
  211.                c:
  212.                cd \gap
  213.  
  214.           Notice that  the file  changes  into  the  QWKREP  directory  and
  215.           invokes  the   REPIMPRT  module,  passing  it  the  name  of  the
  216.           configuration file for Node 1. If you run muliple nodes, you will
  217.           need a  REP.BAT file  for each  node. The only difference between
  218.           the files  would be  the drive and directory designators, and the
  219.           line that  calls up  the REPIMPRT  module. Each  node must  use a
  220.           different configuration  file and  pass the  name of this file to
  221.           the REPIMPRT module.
  222.  
  223.           Both QWK/REP modules can share the same configuation file.
  224.  
  225.  
  226.  
  227.  
  228.                                        Page 4
  229.  
  230.  
  231.  
  232.           GAP Communications                             QWK/REP Sub-System
  233.  
  234.  
  235.           The QWK/REP modules are distributed in two ZIP files:
  236.  
  237.                QWKREP-S.ZIP - Single User
  238.                QWKREP-M.ZIP - Multi User
  239.  
  240.           If you  are running  multi-nodes, you  MUST  use  the  multi-user
  241.           modules.
  242.  
  243.  
  244.  
  245.           In Configuration  (GAPSETUP), on  the Main  Menu Commands screen,
  246.           you enter the security level a user must have in order to use the
  247.           QWK and  REP commands. Notice that these commands are internal to
  248.           GAP and do not utilize your Sysop Defined commands.
  249.  
  250.           Do not configure the QWK/REP modules as Doors. In other words, do
  251.           not place  them in  your DOORS.DAT  file and  do not list them on
  252.           your Doors  Menu. If  you do so, the callers will not be prompted
  253.           if they  actually do  wish to  invoke the  modules. Instead,  the
  254.           doors system  will run the modules and without any prompting, the
  255.           programs will immediately begin a QWK Export or REP Import.
  256.  
  257.           The QWK  and REP commands belong on your Main Menu as part of the
  258.           regular Main Commands.
  259.  
  260.           Both modules  can be  run in local mode. Simple log on to the BBS
  261.           locally and issue the appropriate commands.
  262.  
  263.           When used  from remote, the modules expect that your SEND.BAT and
  264.           RECV.BAT files will invoke a Zmodem Protocol program such as DSZ.
  265.           Your copy of DSZ must be registered or your batch files will have
  266.           to change  "into" the  work directory  that is  passed as the 4th
  267.           parameter to the batch file, invoke the zmodem protocol, and then
  268.           change back to the QWKREP directory.
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.                                        Page 5